home *** CD-ROM | disk | FTP | other *** search
/ Monster Media 1994 #2 / Monster Media No. 2 (Monster Media)(1994).ISO / spitfire / sfcmb10.zip / SFCMB.DOC < prev    next >
Text File  |  1994-08-01  |  9KB  |  185 lines
  1.           ╓───────────────────────────────────────────────────────────╖
  2.           ║      SFCMB v1.0  Spitfire Clean Message Base Utility      ║
  3.           ║            Copyright(C) 1994 by Kevin Cummins             ║
  4.           ║       Crimson Cross BBS (618)253-3608 USR Dual 28.8       ║
  5.           ╙───────────────────────────────────────────────────────────╜
  6.  
  7.  
  8. Brief Description:
  9. ══════════════════
  10.         SFCMB is a utility for SF 3.5+ that attempts to 'clean' up your
  11.         message base from offensive, profane, or unwanted text. It scans
  12.         the message body, as well as the TO:, FROM:, and SUBJECT fields
  13.         in the message header. When a violation is found, SFCMB either
  14.         marks that message for Deletion, or masks the offensive text
  15.         with the '*' character. The action taken is determined by the
  16.         individual sysop.
  17.  
  18. Installation:
  19. ═════════════
  20.         Place SFCMB.EXE in your main Spitfire directory, where it can
  21.         find SFNODE.DAT. It MUST execute from there!
  22.  
  23.         You can run SFCMB without doing anything else as far as
  24.         Installation. SFCMB has an internal list of the most commonly
  25.         found words that are offensive to any BBS sysop concerned with
  26.         this sort of thing. As an OPTION, you can create your own list
  27.         of words that SFCMB will use to scan messages for. If you wish
  28.         to use your own list, read the following info. If you wish to
  29.         use the internal list, you may skip ahead to the section
  30.         entitled 'Execution'.
  31.  
  32.         SFCMB looks for the file, BADWORDS.LST in the default directory
  33.         at runtime. BADWORDS.LST is a file that you must create if you
  34.         choose not to use the internal list. If not found, it uses the
  35.         internal list of words.
  36.  
  37.         NOTE: SFCMB will only use one list, either the internal or the
  38.         external. It will NOT use a combination of both!
  39.  
  40.         BADWORDS.LST can contain up to 25 words, each on a separate
  41.         line, with a 15 character field limit. Simply enter each word on
  42.         its own line (case doesn't matter), and save in standard ASCII
  43.         format.
  44.  
  45.             NOTE: Read this carefully! I have found that a slight
  46.                   problem that can be created when setting up your
  47.                   BADWORDS.LST, and I need to explain. I have provided a
  48.                   work-around for this, *IF* you set it up correctly. I
  49.                   have to be explicit here, so please be forgiving. :)
  50.  
  51.                   For example, if you were to put the word 'ASS' in your
  52.                   list, SFCMB will recognize words like ASSUME, MASS,
  53.                   etc to be offensive, when they are not in fact. The
  54.                   only way I can think of is to look for a space before
  55.                   and after the string for words like this. You CAN add
  56.                   a space of front of the word in the .LST file, but you
  57.                   CANNOT add a space at the end, as it will be trimmed
  58.                   when read into the variable. So, what we will do is
  59.                   substitute another character for a leading or trailing
  60.                   space for words like the above when you want to
  61.                   include them in your list. I am going to use the
  62.                   underscore character (_) to represent the space in the
  63.                   .LST file.
  64.  
  65.                   So, given the above, you could enter _ASS_ in the .LST
  66.                   file, and it would be recognized as offensive only
  67.                   when it is preceded AND followed by a space. The only
  68.                   time it might be missed, is if the word is at the very
  69.                   beginning or very end of a line. With a probability
  70.                   factor figured in, I think this will work at least
  71.                   90%+ of the time.
  72.  
  73.                   Again, using the above word as an example, you can
  74.                   probably think of another word that WOULD be made up
  75.                   of the first word: ***HOLE. I hope you can see that
  76.                   you would need to enter this word as a separate entry
  77.                   to the above, or it will now be overlooked because of
  78.                   the way you have set up the first one.
  79.  
  80.                   While working on this project, I can see that
  81.                   filtering out the bad words can, in some instances, be
  82.                   difficult without affecting some messages that are
  83.                   entirely harmless. If you have any questions, or
  84.                   suggestions regarding the above, PLEASE let me know.
  85.  
  86.  
  87. Execution:
  88. ══════════
  89.  
  90.         To execute SFCMB, you MUST include at least one command line
  91.         parameter, that being the conference number(s) you wish SFCMB to
  92.         process. For example, if you want to run it on only one
  93.         conference, you would enter SFCMB 5. This would cause SFCMB to
  94.         process message area #5.
  95.  
  96.         Entering SFCMB 5..10 would process message areas 5-10. Simple
  97.         enough?
  98.  
  99.         Optionally, you can enter MASK after the conference number, to
  100.         force SFCMB into Mask mode instead of the default of 'MARK
  101.         MESSAGE FOR DELETION' mode. A second parameter is not necessary
  102.         if you wish to use the delete mode.
  103.  
  104.         When a positive scan is found, that message is either masked or
  105.         marked for deletion, and a line is written to the file SFCMB.LOG
  106.         informing the sysop of the Scan time, message number, and
  107.         conference number for future reference.
  108.  
  109.         If no message violations are found, SFCMB simply quits. If it
  110.         does find any, it will import a message to the sysop in
  111.         conference #1 stating that such messages were found and taken
  112.         care of.
  113.  
  114.         SFCMB writes its activities to a file called SFCMB.LOG. It
  115.         records the date and time of each execution of SFCMB, and logs
  116.         the message number and conference number for any offending
  117.         messages found so that you can easily track what SFCMB is doing.
  118.         It also logs if the violation was found in the message body or
  119.         the message header.
  120.  
  121.  
  122. Question?
  123. ═════════
  124.         If I put someone's name or an alias or whatever in BADWORDS.LST,
  125.         will it DELETE any messages entered by that person?
  126.  
  127.         A: Yes, it should. But, keep one thing in mind. SFCMB, in its
  128.         present form, will mark any message that contains that name in
  129.         the message body as well as the message header. For instance, if
  130.         you have JOE BLOW in your BADWORDS.LST, SFCMB will mark any
  131.         message that has that name in it, whether in the message body,
  132.         or the header. The message might not be from JOE BLOW, but could
  133.         just be about him, and still will be marked by SFCMB.
  134.  
  135. Registration:
  136. ═════════════
  137.         There are only two differences in the REGISTERED version of
  138.         SFCMB vs. UNREGISTERED.
  139.  
  140.         UNREGISTERED:
  141.                 1: The message imported to the message base is flagged as
  142.                    <P>ublic.
  143.                 2: This message also has an unregistered reminder in the
  144.                    message body.
  145.  
  146.         REGISTERED:
  147.                 1: The message imported is flagged <P>rivate.
  148.                 2: The unregistered reminder is replaced by your name and
  149.                    registration number.
  150.  
  151.         Registration is provided through Crimson Cross BBS. All you need to
  152.         make your copy of SFCMB registered is the proper registration
  153.         number, which will be available for download from Crimson Cross as
  154.         soon as possible after receiving your registration form. (usually
  155.         less than 24 hours)
  156.  
  157.         Registration for SFCMB is only $5, which I think is plenty
  158.         reasonable for utilities of this sort. I, too, am a sysop so I
  159.         understand the cost involved for BBS operation.  :)
  160.  
  161. Disclaimer:
  162. ═══════════
  163.         Use of this program acknowledges this disclaimer of warranty: "This
  164.         program is supplied as is.  Kevin Cummins disclaims all warranties,
  165.         express or implied, including, without limitation, the warranties
  166.         of merchantability and of fitness of this program for any purpose.
  167.         Kevin Cummins also assumes no liability for damages direct or
  168.         consequential, which may result from the use of this program."
  169.  
  170. Distribution:
  171. ═════════════
  172.         SFSNS is released as Shareware. You are welcome to distribute it
  173.         freely in it's unmodified form. You may evaluate it for a period of
  174.         thirty days, and are then requested to register if you continue
  175.         its use.
  176.  
  177.  
  178. Questions, comments, or program suggestions can be directed to Kevin
  179. Cummins at:
  180.  
  181.         Crimson Cross BBS      618-253-3608     RIME Network
  182.         100 Humphrey Road                       Node: #1390 CCBBS
  183.         Harrisburg, IL 62946
  184.  
  185.